<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dmaps: XDmaPs Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dmaps
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_dma_ps.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XDmaPs Struct Reference<div class="ingroups"><a class="el" href="group__dmaps.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="struct_x_dma_ps.html" title="The XDmaPs driver instance data structure. ">XDmaPs</a> driver instance data structure.  
 <a href="struct_x_dma_ps.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a45c4061741c55585776f412090ef1667"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dma_ps___config.html">XDmaPs_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps.html#a45c4061741c55585776f412090ef1667">Config</a></td></tr>
<tr class="memdesc:a45c4061741c55585776f412090ef1667"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration data structure.  <a href="#a45c4061741c55585776f412090ef1667">More...</a><br/></td></tr>
<tr class="separator:a45c4061741c55585776f412090ef1667"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e39ae2cf0255dd2835c9b55449aaaf3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps.html#a0e39ae2cf0255dd2835c9b55449aaaf3">IsReady</a></td></tr>
<tr class="memdesc:a0e39ae2cf0255dd2835c9b55449aaaf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is Ready.  <a href="#a0e39ae2cf0255dd2835c9b55449aaaf3">More...</a><br/></td></tr>
<tr class="separator:a0e39ae2cf0255dd2835c9b55449aaaf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61881a8aab6272aa815bdbb8babf3a41"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps.html#a61881a8aab6272aa815bdbb8babf3a41">CacheLength</a></td></tr>
<tr class="memdesc:a61881a8aab6272aa815bdbb8babf3a41"><td class="mdescLeft">&#160;</td><td class="mdescRight">icache length  <a href="#a61881a8aab6272aa815bdbb8babf3a41">More...</a><br/></td></tr>
<tr class="separator:a61881a8aab6272aa815bdbb8babf3a41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade567db033942a4601c95b04761906e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dmaps.html#ga5dba8cc7cd39c53eed1dabac803ce74f">XDmaPsFaultHandler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps.html#ade567db033942a4601c95b04761906e2">FaultHandler</a></td></tr>
<tr class="memdesc:ade567db033942a4601c95b04761906e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">fault interrupt handler  <a href="#ade567db033942a4601c95b04761906e2">More...</a><br/></td></tr>
<tr class="separator:ade567db033942a4601c95b04761906e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4be3d7e948f1eb200b732a36e021b678"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps.html#a4be3d7e948f1eb200b732a36e021b678">FaultRef</a></td></tr>
<tr class="memdesc:a4be3d7e948f1eb200b732a36e021b678"><td class="mdescLeft">&#160;</td><td class="mdescRight">fault call back data  <a href="#a4be3d7e948f1eb200b732a36e021b678">More...</a><br/></td></tr>
<tr class="separator:a4be3d7e948f1eb200b732a36e021b678"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb46f6085dc9e591775679f026025819"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dma_ps___channel_data.html">XDmaPs_ChannelData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps.html#afb46f6085dc9e591775679f026025819">Chans</a> [XDMAPS_CHANNELS_PER_DEV]</td></tr>
<tr class="memdesc:afb46f6085dc9e591775679f026025819"><td class="mdescLeft">&#160;</td><td class="mdescRight">channel data  <a href="#afb46f6085dc9e591775679f026025819">More...</a><br/></td></tr>
<tr class="separator:afb46f6085dc9e591775679f026025819"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="struct_x_dma_ps.html" title="The XDmaPs driver instance data structure. ">XDmaPs</a> driver instance data structure. </p>
<p>A pointer to an instance data structure is passed around by functions to refer to a specific driver instance. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a61881a8aab6272aa815bdbb8babf3a41"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDmaPs::CacheLength</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>icache length </p>

<p>Referenced by <a class="el" href="group__dmaps.html#ga2fed90dfba1ff9f472b40ed492d78b4c">XDmaPs_CfgInitialize()</a>, and <a class="el" href="group__dmaps.html#gabc2e04f69037f0bdba33275ae017af8a">XDmaPs_GenDmaProg()</a>.</p>

</div>
</div>
<a class="anchor" id="afb46f6085dc9e591775679f026025819"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_dma_ps___channel_data.html">XDmaPs_ChannelData</a> XDmaPs::Chans[XDMAPS_CHANNELS_PER_DEV]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>channel data </p>

<p>Referenced by <a class="el" href="group__dmaps.html#ga2fed90dfba1ff9f472b40ed492d78b4c">XDmaPs_CfgInitialize()</a>, <a class="el" href="group__dmaps.html#gae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR()</a>, <a class="el" href="group__dmaps.html#ga96c4c2e45ab31a22f05767c24db425ea">XDmaPs_FreeDmaProg()</a>, <a class="el" href="group__dmaps.html#gabc2e04f69037f0bdba33275ae017af8a">XDmaPs_GenDmaProg()</a>, <a class="el" href="group__dmaps.html#ga05047e523efd0dcc0e1f3ba16a32a796">XDmaPs_IsActive()</a>, <a class="el" href="group__dmaps.html#gaccf32b08856fbe62745a4d0552aa1bff">XDmaPs_SetDoneHandler()</a>, and <a class="el" href="group__dmaps.html#ga3691ba115c788c4f68a05cf05c486eeb">XDmaPs_Start()</a>.</p>

</div>
</div>
<a class="anchor" id="a45c4061741c55585776f412090ef1667"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_dma_ps___config.html">XDmaPs_Config</a> XDmaPs::Config</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configuration data structure. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#ga2fed90dfba1ff9f472b40ed492d78b4c">XDmaPs_CfgInitialize()</a>, <a class="el" href="xdmaps__example__w__intr_8c.html#ad138547e71c03c7c9c30a0620a1569d2">XDmaPs_Example_W_Intr()</a>, <a class="el" href="group__dmaps.html#gae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR()</a>, <a class="el" href="group__dmaps.html#ga593458e8f6ac55566fc235e8a93b9890">XDmaPs_ResetChannel()</a>, <a class="el" href="group__dmaps.html#ga65cc22a994eb1ca6a9c56d86d469242e">XDmaPs_ResetManager()</a>, <a class="el" href="group__dmaps.html#ga711e54b9c033b127fb582bde320f8823">XDmaPs_SelfTest()</a>, and <a class="el" href="group__dmaps.html#ga3691ba115c788c4f68a05cf05c486eeb">XDmaPs_Start()</a>.</p>

</div>
</div>
<a class="anchor" id="ade567db033942a4601c95b04761906e2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__dmaps.html#ga5dba8cc7cd39c53eed1dabac803ce74f">XDmaPsFaultHandler</a> XDmaPs::FaultHandler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>fault interrupt handler </p>

<p>Referenced by <a class="el" href="group__dmaps.html#gae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR()</a>, and <a class="el" href="group__dmaps.html#gacda5c5523ed24451a7efacc7b9257fa3">XDmaPs_SetFaultHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a4be3d7e948f1eb200b732a36e021b678"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XDmaPs::FaultRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>fault call back data </p>

<p>Referenced by <a class="el" href="group__dmaps.html#gae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR()</a>, and <a class="el" href="group__dmaps.html#gacda5c5523ed24451a7efacc7b9257fa3">XDmaPs_SetFaultHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a0e39ae2cf0255dd2835c9b55449aaaf3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDmaPs::IsReady</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is Ready. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#ga2fed90dfba1ff9f472b40ed492d78b4c">XDmaPs_CfgInitialize()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
